/*
 * Sonatype Nexus (TM) Open Source Version
 * Copyright (c) 2008-present Sonatype, Inc.
 * All rights reserved. Includes the third-party code listed at http://links.sonatype.com/products/nexus/oss/attributions.
 *
 * This program and the accompanying materials are made available under the terms of the Eclipse Public License Version 1.0,
 * which accompanies this distribution and is available at http://www.eclipse.org/legal/epl-v10.html.
 *
 * Sonatype Nexus (TM) Professional Version is available from Sonatype, Inc. "Sonatype" and "Sonatype Nexus" are trademarks
 * of Sonatype, Inc. Apache Maven is a trademark of the Apache Software Foundation. M2eclipse is a trademark of the
 * Eclipse Foundation. All other trademarks are the property of their respective owners.
 */
package org.sonatype.nexus.jmx.reflect;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.management.MBeanOperationInfo;

/**
 * Marks a method as a managed operation.
 *
 * @see ManagedObject
 * @see ManagedAttribute
 * @since 3.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface ManagedOperation
{
  /**
   * Customized attribute name.  If left unset will use name from method.
   */
  String name() default "";

  /**
   * Optional operation impact.
   *
   * @see MBeanOperationInfo#ACTION
   * @see MBeanOperationInfo#ACTION_INFO
   * @see MBeanOperationInfo#INFO
   * @see MBeanOperationInfo#UNKNOWN
   */
  int impact() default MBeanOperationInfo.UNKNOWN;

  /**
   * Optional operation description.
   */
  String description() default "";
}
